Skip to content

Fix docs deploy breakage from mkdocstrings config drift and stale notebook API usage#78

Merged
pluflou merged 2 commits into
mainfrom
copilot/fix-deploy-ubuntu-latest-310
Jul 4, 2026
Merged

Fix docs deploy breakage from mkdocstrings config drift and stale notebook API usage#78
pluflou merged 2 commits into
mainfrom
copilot/fix-deploy-ubuntu-latest-310

Conversation

Copilot AI commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

The deploy (ubuntu-latest, 3.10) documentation workflow was failing during docs build after a dependency/API drift in mkdocstrings, and one executed notebook still used the pre-dict Image.get_sizes() interface. This updates the docs config and notebook examples so the publish workflow can complete again.

  • Docs build config

    • Update mkdocs.yml to use the current mkdocstrings Python handler schema.
    • Replace the removed selection block with options, preserving the existing doc rendering behavior.
  • Executable notebook examples

    • Update notebook cells that unpacked Image.get_sizes() as a tuple.
    • Switch examples to the current dict-based access pattern used by the library.
  • Scope

    • Changes are limited to documentation/build configuration and executable example notebooks.
    • No production package behavior was changed.

Example of the notebook API correction:

fit_res = im.get_sizes(method="gaussian", show_plots=True)

xsize = fit_res["xrms"]
ysize = fit_res["yrms"]
xsize_error = fit_res["xrms_err"]
ysize_error = fit_res["yrms_err"]
x_amplitude = fit_res["xamp"]
y_amplitude = fit_res["yamp"]

Copilot AI changed the title [WIP] Fix failing GitHub Actions job deploy (ubuntu-latest, 3.10) Fix docs deploy breakage from mkdocstrings config drift and stale notebook API usage Jul 3, 2026
Copilot AI requested a review from pluflou July 3, 2026 23:56
@pluflou pluflou marked this pull request as ready for review July 4, 2026 00:01
@pluflou pluflou merged commit 8eef1d4 into main Jul 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants